Application Group API

GET /api/v2/applicationGroup/group

Description

Get all application groups and basic information about the applications for each group.

Header Parameters

Name	Description	Type	Required	Default
Authorization	Bearer API token/key. The format is Bearer <API_key>	String	Yes
orgId	The ID of the organization. The format is OrgId:OrgName	String	Yes

Query Parameters

Name	Description	Type	Required	Default
calculateEventStats	Not in use. The calculation of the number of open events or alerts should be performed or no	Boolean	No	true
days	The number of days to go back to	Integer	No	1

CURL Example

The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID> & <API-TOKEN> are variables.

curl --location 'https://<NCE-IP>/api/v2/applicationGroup/group?calculateEventStats=true&days=1' \
--header 'orgId: <ORG-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'

Response

Upon a successful request, the authentication API returns Status code 200 with the following body:

Name	Description	Type
level	Level number	Integer
levelName	Level name	String
groupElements	List of all application groups	Array of objects
- groupId	Group ID	String
- groupName	Group name	String
- appList	List of applications in this application group	Array of objects
-- applicationId	Application ID	String
-- applicationName	Application name	String
-- level	Level number	Integer
-- levelName	Level name	String
- isJVM		Boolean
- isSystemCreated	Boolean true/false if the element is automatically created	Boolean
- lastCMDBUpdateTime	Last time the record was pushed to the CMDB. The format is timeyyyy-MM-ddThh:mm:ss.tttZ	String
child		Object
- level	Level number	Integer
- levelName	Level name	String
- groupElements	List of all children elements	Array of objects
-- groupId	Group ID	String
-- groupName	Group name	String
-- appList	List of applications in this child	Array of objects
-- isJVM		Boolean
-- isSystemCreated	Boolean true/false if the element is automatically created	Boolean
-- lastCMDBUpdateTime	Last time the record was pushed to the CMDB. The format is timeyyyy-MM-ddThh:mm:ss.tttZ	String
- child	Sub-children	Array of objects

GET /api/v2/applicationGroup/groupTopology/{groupID}

Description

Get the topology links for all devices in a particular application group.

Path Parameters

Name	Description	Type	Required	Default
groupID	Application group ID	String	Yes

Header Parameters

Name	Description	Type	Required	Default
Authorization	Bearer API token/key. The format is Bearer <API_key>	String	Yes
orgId	The ID of the organization. The format is OrgId:OrgName	String	Yes

CURL Example

The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <API-TOKEN> & <GROUP-ID> are variables.

curl --location 'https://<NCE-IP>/api/v2/applicationGroup/groupTopology/<GROUP-ID>' \
--header 'orgId: <ORG-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'

Response

Upon a successful request, the authentication API returns Status code 200 with the following body:

Name	Description	Type
appGroupName	Application group name	String
appGroupId	Application group ID	String
subGroups	List of applications in this application group	Array of objects
- appGroupName	Application name	String
- appGroupId	Application ID	String
- subGroups	List of sub-applications in this application	Array of objects
- children	List of application children	Array of objects
- level	Level number	Integer
- levelName	Level name	String
children	List of application sub-groups	Array of objects
level	Level number	Integer
levelName	Level name	String